Fix "Edit on Github" links#577
Merged
santisoler merged 3 commits intomainfrom Dec 4, 2024
Merged
Conversation
Fix the "Edit on Github" links by removing the `_templates/breadcrumbs.html` file: Sphinx and the RTD theme can generate those links if the docs are correctly configured. Add `"conf_py_path"` to the `html_context` dictionary in Sphinx configuration file, so the links to the source files work correctly. Minor updates on the configuration file to avoid some warnings: remove the `language=None` and `html_theme_path`.
Member
Author
|
@lheagy this should fix those links without having to create our own Sphinx extension: RTD is capable of resolving those links out of the box if the configuration is correctly set. I noticed that the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix the "Edit on Github" links by removing the
_templates/breadcrumbs.htmlfile: Sphinx and the RTD theme can generate those links if the docs are correctly configured. Add"conf_py_path"to thehtml_contextdictionary in Sphinx configuration file, so the links to the source files work correctly. Minor updates on the configuration file to avoid some warnings: remove thelanguage=Noneandhtml_theme_path.Alternative solution to #575